/*
 * Copyright 2010 Yannick Stucki (yannickstucki.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.yannickstucki.android.musicqueue.data;

import android.database.Cursor;

/**
 * A song cursor that returns all the starred songs.
 * 
 * @author Yannick Stucki (yannickstucki@gmail.com)
 *
 */
public class SongCursorStarred implements ISongCursor {

  /**
   * The column name for the unique id in the database.
   */
  private static final String UNIQUE_ID_COLUMN_NAME = "uniqueID";
  
  /**
   * The column index for the unique id in the database.
   */
  private int uniqueIdColumnIndex;
  
  /**
   * The actual cursor.
   */
  private Cursor cursor;
  
  /**
   * The database on which the query is performed.
   */
  private IDatabase database;
  
  /**
   * The constructor sets the references.
   */
  public SongCursorStarred(IDatabase database) {
    this.database = database;
  }
  
  @Override
  public boolean query() {
    cursor = database.getStarredSongCursor();
    uniqueIdColumnIndex = cursor.getColumnIndex(UNIQUE_ID_COLUMN_NAME);
    return cursor.moveToFirst();
  }
  
  @Override
  public boolean moveToNext() {
    return cursor.moveToNext();
  }

  @Override
  public Song getSong() {
    return new Song(cursor.getString(uniqueIdColumnIndex));
  }
}
